Examples

Embedded images

The following online image in your markdown source will be embedded in the generated html with Base64

The following local image in your markdown source will be embedded in the generated html

Some text with LaTeX-like formulae using KaTeX

Surround your LaTeX with a single $ on each side for inline rendering. Use two $ for block rendering. This mode uses bigger symbols and centres the result.

This is an inline LaTeX-like formula $c=m^e \mod n$ describing textbook RSA encryption.

And this is a block formula:

$$f(x) = \int_{-\infty}^\infty \hat f(\xi)\,e^{2 \pi i \xi x} \,d\xi$$

Highlighted code

The following code will be highlighted with highlight.js. Default style is 'vs2015' but you can choose any highlight.js style passing the name to the command with --highlightjs-style <stylename>.

'use strict'

const mdChords = require('markdown-it')({ breaks: true }).use(require('markdown-it-chords'))

module.exports = function chords (md) {
  const defaultRender = md.renderer.rules.fence

  md.renderer.rules.fence = function (tokens, idx, options, env, self) {
    const token = tokens[idx]

    if (token.tag === 'code' && token.info === 'song') {
      return `<div class="song">${mdChords.render(token.content)}</song>`
    }

    // pass token to default renderer.
    return defaultRender(tokens, idx, options, env, self)
  }
}

Song lyrics with chords

You can also render songs (lyrics with chords) using markdown-it-chords. For compatibility reasons, only songs in fenced code blocks with language song will be rendered.